home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / dev / misc / adhelp10.readme < prev    next >
Encoding:
Text File  |  1994-10-08  |  7.1 KB  |  229 lines
  1. Short: ADHelp 1.0 - help system for programmers
  2. Type: dev/misc
  3. Author: muellerg@informatik.tu-muenchen.de
  4. Uploader: maurer@informatik.tu-muenchen.de
  5.  
  6. TYPE
  7.  
  8.      dev/misc
  9.  
  10.  
  11. TITLE
  12.  
  13.      ADHelp - Powerful help system for programmers
  14.  
  15.  
  16. VERSION
  17.  
  18.      1.0 - initial release (11-Jun-1994)
  19.  
  20.  
  21. COMPANY
  22.  
  23.      None
  24.  
  25.  
  26. AUTHOR
  27.  
  28.      Gerhard Müller internet: muellerg@informatik.tu-muenchen.de
  29.                     Fido    : Gerhard Mueller @ 2:2480/3508.38
  30.                     Z-Netz  : GANDALF@AMC.ZER
  31.  
  32.      Klarweinstr. 32
  33.      81247 München
  34.  
  35.      GERMANY
  36.  
  37.  
  38. DESCRIPTION
  39.  
  40.      ADHelp integrates the search in autodoc files, include files
  41.      (C  or Assembler), man pages or SAS/C's sc_lib.guide in your
  42.      favourite AREXX-capeable editor like CygnusED or EDGE.
  43.  
  44.      You can search after information with a single key.  Imagine
  45.      you  want  to  use  AllocMem, but you don't know what ADHelp
  46.      needs  as  parameters.  With a single key press, your editor
  47.      will  open  a  new  "view"  or "window", and you can see the
  48.      autodoc page to AllocMem.  There MEMF_FAST is explained.  If
  49.      you want to know how and where MEMF_FAST is defined, go with
  50.      the  cursor  over the word MEMF_FAST and press the installed
  51.      search key again.  A new window is opened with exec/memory.h
  52.      as contents.
  53.  
  54.      Very easy is also the browsing throuh structures!  Just move
  55.      the  cursor over "ExecBase", for example, and a secound later
  56.      you see the definition.
  57.  
  58.      Another  thing  that  is very easy is searching for specific
  59.      words.   Imagine  you  know  that  there  is a function or a
  60.      define  that  starts with SetW*.  Just enter this, press the
  61.      help key, and you will get a list of entries, like
  62.  
  63.         graphics.library/SetWriteMask(AUTODOC:graphics.doc)
  64.         intuition.library/SetWindowPointerA(AUTODOC:intuition.doc)
  65.         intuition.library/SetWindowTitles(AUTODOC:intuition.doc)
  66.         gfxmacros.h/SetWrMsk(gcc:os-include/graphics/gfxmacros.h)
  67.  
  68.      Just  move  your  cursor  to your wanted function, press the
  69.      search  key  again,  and,  viola!   Searching was never such
  70.      easy.
  71.  
  72.      Sometimes  you  know not exactly how the function(definition
  73.      etc..)  is  called, but you know where it should be defined,
  74.      is  is a man page from unix, is it a definition in a include
  75.      file, or perhaps a function in , say, dos.library.
  76.  
  77.      With  the  extended help, you can spcify where ADHelp should
  78.      look for you. Here some examples:
  79.  
  80.      *.0/* : a list of all functions/programs described in manpages
  81.      is shown.
  82.  
  83.      strc*0*/* :
  84.  
  85.        strcasecmp.0/strcasecmp(gcc:man2/cat3/strcasecmp.0)
  86.        strcat.0/strcat(gcc:man2/cat3/strcat.0)
  87.        strchr.0/strchr(gcc:man2/cat3/strchr.0)
  88.        strcmp.0/strcmp(gcc:man2/cat3/strcmp.0)
  89.        strcoll.0/strcoll(gcc:man2/cat3/strcoll.0)
  90.        strcpy.0/strcpy(gcc:man2/cat3/strcpy.0)
  91.        strcspn.0/strcspn(gcc:man2/cat3/strcspn.0)
  92.  
  93.      [a-c]*.h/*Z* :
  94.  
  95.        A list of all defines/structures/typedefs... in include
  96.        files which start with a, b or d is generated.
  97.  
  98.      dos*/GetP* :
  99.  
  100.        dos.library/GetProgramDir(AUTODOC:dos.doc)
  101.        dos.library/GetProgramName(AUTODOC:dos.doc)
  102.        dos.library/GetPrompt(AUTODOC:dos.doc)
  103.  
  104.  
  105. USAGE
  106.  
  107.      [some additional examples]
  108.  
  109.        int*/SetP* -> Help Key -> new "view" (Editor window):
  110.  
  111.        intuition.library/SetPointer(AUTODOC:intuition.doc)
  112.        intuition.library/SetPrefs(AUTODOC:intuition.doc)
  113.        intuition.library/SetPubScreenModes(AUTODOC:intuition.doc)
  114.  
  115.  
  116.      AllocMem -> Help Key -> new view with:
  117.  
  118.        [Autodoc to AllocMem]
  119.  
  120.  
  121.      MEMF_CLEAR -> Help Key -> new view with:
  122.  
  123.        [exec/memory.h, cursor stands on #define of MEMF_CLEAR]
  124.  
  125.  
  126.      *.device/CMD_READ -> Help Key -> new view with:
  127.  
  128.        audio.device/CMD_READ(AUTODOC:audio.doc)
  129.        clipboard.device/CMD_READ(AUTODOC:clipboard.doc)
  130.        console.device/CMD_READ(AUTODOC:console.doc)
  131.        narrator.device/CMD_READ(AUTODOC:narrator.doc)
  132.        parallel.device/CMD_READ(AUTODOC:parallel.doc)
  133.        serial.device/CMD_READ(AUTODOC:serial.doc)
  134.        trackdisk.device/CMD_READ(AUTODOC:trackdisk.doc)
  135.  
  136.  
  137.      narrator.device/CMD_READ(AUTODOC:narrator.doc) -> Help Key
  138.      -> new view with autodoc page to CMD_READ of the narrator
  139.      device.
  140.  
  141.  
  142. PRICE
  143.  
  144.      Suggested shareware/registration fee for keyfile is US$10 or
  145.      DM 15. There is a discount if you order more than 2 keyfiles.
  146.  
  147.      Without keyfile a "shareware reminder requester" sometimes
  148.      shows up. (ADHelp is not crippled in any way.)
  149.  
  150.      Please see the packet for exact payment instructions.
  151.  
  152.  
  153. SPECIAL REQUIREMENTS
  154.  
  155.      Requires AmigaOS 2.04 (V37), Commodores Installer
  156.  
  157.      Editor with AREXX-Interface like CygnusED, EDGE or GoldED
  158.  
  159.      Very useful is the Native Development Kit 3.1 (Includes &
  160.      Autodocs)
  161.  
  162.  
  163. HOST NAME
  164.  
  165.      wuarchive.wustl.edu (128.252.135.4) [AmiNet]
  166.      (and any other AmiNet mirror)
  167.  
  168.  
  169. DIRECTORY
  170.  
  171.      Aminet : /pub/aminet/dev/misc
  172.  
  173.  
  174. FILE NAME
  175.  
  176.      ADHelp10.lha (73914 bytes)
  177.  
  178.  
  179. DISTRIBUTABILITY
  180.  
  181.      ADHelp  (C)  1994 Gerhard Müller, all rights reserved.  This
  182.      archive  is  freely  distributable as long as the archive is
  183.      intact   and   only   a  nominal  fee  is  charged  for  its
  184.      distribution.
  185.  
  186.  
  187. BACKGROUND
  188.  
  189.      ADHelp  was  written  from a programmer for programmers.  If
  190.      you  use  ADHelp,  you will fast not know how you could work
  191.      without.
  192.  
  193.  
  194. OTHER
  195.  
  196.      XPK-support
  197.  
  198.      Support available direct from the author via EMail.
  199.  
  200.  
  201.  
  202. ============================= Archive contents =============================
  203.  
  204. Original  Packed Ratio    Date     Time    Name
  205. -------- ------- ----- --------- --------  -------------
  206.    34040   16426 51.7% 11-Jun-94 17:15:24  ADHelp10/ADhelp
  207.    43825   14524 66.8% 12-Jun-94 16:55:24  ADHelp10/ADhelp.guide
  208.     1553     634 59.1% 11-Jun-94 15:06:48  ADHelp10/ADhelp.guide.info
  209.     1024     809 20.9% 11-Jun-94 14:59:06  ADHelp10/GetAsmIncludeIndex
  210.      722     345 52.2% 11-Jun-94 14:59:38  ADHelp10/rexx/ADHelp.ced
  211.     1023     438 57.1% 11-Jun-94 14:59:38  ADHelp10/rexx/ADHelp.edge
  212.     1449     666 54.0% 11-Jun-94 14:59:38  ADHelp10/rexx/ADHelp.ged
  213.     1440     655 54.5% 11-Jun-94 14:59:38  ADHelp10/rexx/ADHelpAsk.ged
  214.     3992     741 81.4% 11-Jun-94 15:06:48  ADHelp10/ADHelp.info
  215.     7012    3908 44.2% 11-Jun-94 14:59:06  ADHelp10/ConvertTabsToSpaces
  216.    10620    5853 44.8% 12-Jun-94 16:19:22  ADHelp10/GetAutodocOffsets
  217.    11632    6247 46.2% 12-Jun-94 16:20:32  ADHelp10/GetIncludeStructsOffsets
  218.    10244    5749 43.8% 11-Jun-94 14:59:06  ADHelp10/GetManPagesOffsets
  219.     1830     766 58.1% 11-Jun-94 14:59:38  ADHelp10/rexx/enhanced/ADHelp.ged
  220.     1721     706 58.9% 11-Jun-94 14:59:38  ADHelp10/rexx/enhanced/ADHelpAsk.ged
  221.     2278     568 75.0% 11-Jun-94 15:56:14  ADHelp10.info
  222.     5260    3107 40.9% 11-Jun-94 14:59:06  ADHelp10/GetSCLibOffsets
  223.    20041    5495 72.5% 12-Jun-94 16:48:48  ADHelp10/Install ADHelp
  224.      733     363 50.4% 11-Jun-94 16:04:02  ADHelp10/Install ADHelp.info
  225.     2827    1153 59.2% 11-Jun-94 14:59:06  ADHelp10/Registration_form
  226.     6768    3719 45.0% 11-Jun-94 14:59:06  ADHelp10/RemoveAnsiFromManpages
  227. -------- ------- ----- --------- --------
  228.   170034   72872 57.1% 16-Jun-94 08:50:24   21 files
  229.